/* Copyright (C) 2011 rccloud.com All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.rccloud.gwtproxyc.shared.annotation;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import com.rccloud.gwtproxyc.shared.DefaultProxyConverter;
import com.rccloud.gwtproxyc.shared.ProxyConverter;

/**
 * This annotation is used to specify a proxy converter info. If it's used on a
 * class, it means all fields of class will be converted except the field
 * annotated {@link com.rccloud.gwtproxyc.shared.annotation.NoProxy NoProxy}. If
 * it's used on a field, it means the field will be converted.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.FIELD })
public @interface AutoProxy {

	/**
	 * If it uses on a class, it indicates the entity class type. If it uses on
	 * a field, it indicates the field type of entity class.
	 * 
	 * @return Entity class type
	 */
	Class<?> value();

	/**
	 * Indicate the field name of entity class
	 * 
	 * @return Field name of entity class
	 */
	String name() default "";

	/**
	 * The converter for field
	 * 
	 * @return The converter
	 */
	Class<? extends ProxyConverter> converter() default DefaultProxyConverter.class;
}